docs(outputs.dynatrace): Use TOML comment in api_token example#19204
Open
jstirnaman wants to merge 1 commit into
Open
docs(outputs.dynatrace): Use TOML comment in api_token example#19204jstirnaman wants to merge 1 commit into
jstirnaman wants to merge 1 commit into
Conversation
The example used a C-style // comment, which is invalid in TOML. Use # so the snippet parses if copied as-is.
telegraf-tiger
Bot
added
docs
skartikey
changed the title
Contributor
|
@jstirnaman The |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
api_tokenexample used a C-style//comment, which is invalid in TOML.Use
#so the snippet parses if copied as-is.This fix is in a freestanding example block in the README prose, not the
generated
@sample.confblock (which is separate in this README andunaffected), so no
sample.confchange ormake docsrun is needed.Found while adding code-block linting to the InfluxData docs site, which
generates the published plugin docs from these READMEs.
Verified in Telegraf 1.39.1: before,
line 4: invalid TOML syntax; after, theconfig loads (
Loaded inputs: cpu).Checklist
Related issues
Related to #19201 (tracking issue for this cleanup; item resolved in this PR)